<?xml version='1.0' encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <link href="cpip.css" rel="stylesheet" type="text/css" />
    <title>File: /Users/paulross/dev/Python-3.6.2/Include/tupleobject.h</title>
  </head>
  <body>
    <h1>File: /Users/paulross/dev/Python-3.6.2/Include/tupleobject.h</h1>
    <p>Green shading in the line number column
means the source is part of the translation unit, red means it is conditionally excluded.
Highlighted line numbers link to the translation unit page. Highlighted macros link to
the macro page.</p>
    <pre><a name="1" /><span class="True">       1:</span> 
<a name="2" /><span class="True">       2:</span> <span class="k">/* Tuple object interface */</span>
<a name="3" /><span class="True">       3:</span> 
<a name="4" /><span class="True">       4:</span> <span class="f">#</span><span class="n">ifndef</span> <a href="macros_noref.html#_UHlfVFVQTEVPQkpFQ1RfSF8w"><span class="b">Py_TUPLEOBJECT_H</span></a>
<a name="5" /><span class="True">       5:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_noref.html#_UHlfVFVQTEVPQkpFQ1RfSF8w"><span class="b">Py_TUPLEOBJECT_H</span></a>
<a name="6" /><span class="False">       6:</span> <span class="f">#</span><span class="n">ifdef</span> <span class="b">__cplusplus</span>
<a name="7" /><span class="False">       7:</span> <span class="m">extern</span> <span class="e">&quot;C&quot;</span> <span class="f">{</span>
<a name="8" /><span class="True">       8:</span> <span class="f">#</span><span class="n">endif</span>
<a name="9" /><span class="True">       9:</span> 
<a name="10" /><span class="True">      10:</span> <span class="k">/*</span>
<a name="11" /><span class="True">      11:</span> <span class="k">Another generally useful object type is a tuple of object pointers.</span>
<a name="12" /><span class="True">      12:</span> <span class="k">For Python, this is an immutable type.  C code can change the tuple items</span>
<a name="13" /><span class="True">      13:</span> <span class="k">(but not their number), and even use tuples are general-purpose arrays of</span>
<a name="14" /><span class="True">      14:</span> <span class="k">object references, but in general only brand new tuples should be mutated,</span>
<a name="15" /><span class="True">      15:</span> <span class="k">not ones that might already have been exposed to Python code.</span>
<a name="16" /><span class="True">      16:</span> <span class="k"></span>
<a name="17" /><span class="True">      17:</span> <span class="k">*** WARNING *** PyTuple_SetItem does not increment the new item&apos;s reference</span>
<a name="18" /><span class="True">      18:</span> <span class="k">count, but does decrement the reference count of the item it replaces,</span>
<a name="19" /><span class="True">      19:</span> <span class="k">if not nil.  It does *decrement* the reference count if it is *not*</span>
<a name="20" /><span class="True">      20:</span> <span class="k">inserted in the tuple.  Similarly, PyTuple_GetItem does not increment the</span>
<a name="21" /><span class="True">      21:</span> <span class="k">returned item&apos;s reference count.</span>
<a name="22" /><span class="True">      22:</span> <span class="k">*/</span>
<a name="23" /><span class="True">      23:</span> 
<a name="24" /><span class="True">      24:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="25" /><span class="True">      25:</span> <span class="m">typedef</span> <span class="m">struct</span> <span class="f">{</span>
<a name="26" /><span class="True">      26:</span>     <a href="macros_ref.html#_UHlPYmplY3RfVkFSX0hFQURfMA__"><span class="b">PyObject_VAR_HEAD</span></a>
<a name="27" /><span class="True">      27:</span>     <span class="b">PyObject</span> <span class="f">*</span><span class="b">ob_item</span><span class="f">[</span><span class="c">1</span><span class="f">]</span><span class="f">;</span>
<a name="28" /><span class="True">      28:</span> 
<a name="29" /><span class="True">      29:</span>     <span class="k">/* ob_item contains space for &apos;ob_size&apos; elements.</span>
<a name="30" /><span class="True">      30:</span> <span class="k">     * Items must normally not be NULL, except during construction when</span>
<a name="31" /><span class="True">      31:</span> <span class="k">     * the tuple is not yet visible outside the function that builds it.</span>
<a name="32" /><span class="True">      32:</span> <span class="k">     */</span>
<a name="33" /><span class="True">      33:</span> <span class="f">}</span> <span class="b">PyTupleObject</span><span class="f">;</span>
<a name="34" /><span class="True">      34:</span> <span class="f">#</span><span class="n">endif</span>
<a name="35" /><span class="True">      35:</span> 
<a name="36" /><span class="True">      36:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PyTuple_Type</span><span class="f">;</span>
<a name="37" /><span class="True">      37:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PyTupleIter_Type</span><span class="f">;</span>
<a name="38" /><span class="True">      38:</span> 
<a name="39" /><span class="True">      39:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlUdXBsZV9DaGVja18w"><span class="b">PyTuple_Check</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> \
<a name="40" /><span class="True">      40:</span>                  <a href="macros_ref.html#_UHlUeXBlX0Zhc3RTdWJjbGFzc18w"><span class="b">PyType_FastSubclass</span></a><span class="f">(</span><a href="macros_ref.html#_UHlfVFlQRV8w"><span class="b">Py_TYPE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">,</span> <a href="macros_ref.html#_UHlfVFBGTEFHU19UVVBMRV9TVUJDTEFTU18w"><span class="b">Py_TPFLAGS_TUPLE_SUBCLASS</span></a><span class="f">)</span>
<a name="41" /><span class="True">      41:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlUdXBsZV9DaGVja0V4YWN0XzA_"><span class="b">PyTuple_CheckExact</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> <span class="f">(</span><a href="macros_ref.html#_UHlfVFlQRV8w"><span class="b">Py_TYPE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> <span class="f">==</span> <span class="f">&amp;</span><span class="b">PyTuple_Type</span><span class="f">)</span>
<a name="42" /><span class="True">      42:</span> 
<a name="43" /><span class="True">      43:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyTuple_New</span><span class="f">(</span><span class="b">Py_ssize_t</span> <span class="b">size</span><span class="f">)</span><span class="f">;</span>
<a name="44" /><span class="True">      44:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">Py_ssize_t</span><span class="f">)</span> <span class="b">PyTuple_Size</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="45" /><span class="True">      45:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyTuple_GetItem</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">)</span><span class="f">;</span>
<a name="46" /><span class="True">      46:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyTuple_SetItem</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="47" /><span class="True">      47:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyTuple_GetSlice</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">)</span><span class="f">;</span>
<a name="48" /><span class="True">      48:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="49" /><span class="True">      49:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">_PyTuple_Resize</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">)</span><span class="f">;</span>
<a name="50" /><span class="True">      50:</span> <span class="f">#</span><span class="n">endif</span>
<a name="51" /><span class="True">      51:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyTuple_Pack</span><span class="f">(</span><span class="b">Py_ssize_t</span><span class="f">,</span> <span class="f">...</span><span class="f">)</span><span class="f">;</span>
<a name="52" /><span class="True">      52:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="53" /><span class="True">      53:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">void</span><span class="f">)</span> <span class="b">_PyTuple_MaybeUntrack</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="54" /><span class="True">      54:</span> <span class="f">#</span><span class="n">endif</span>
<a name="55" /><span class="True">      55:</span> 
<a name="56" /><span class="True">      56:</span> <span class="k">/* Macro, trading safety for speed */</span>
<a name="57" /><span class="True">      57:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="58" /><span class="True">      58:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlUdXBsZV9HRVRfSVRFTV8w"><span class="b">PyTuple_GET_ITEM</span></a><span class="f">(</span><span class="b">op</span><span class="f">,</span> <span class="b">i</span><span class="f">)</span> <span class="f">(</span><span class="f">(</span><span class="f">(</span><span class="b">PyTupleObject</span> <span class="f">*</span><span class="f">)</span><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">)</span><span class="f">-&gt;</span><span class="b">ob_item</span><span class="f">[</span><span class="b">i</span><span class="f">]</span><span class="f">)</span>
<a name="59" /><span class="True">      59:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlUdXBsZV9HRVRfU0laRV8w"><span class="b">PyTuple_GET_SIZE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span>    <a href="macros_ref.html#_UHlfU0laRV8w"><span class="b">Py_SIZE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span>
<a name="60" /><span class="True">      60:</span> 
<a name="61" /><span class="True">      61:</span> <span class="k">/* Macro, *only* to be used to fill in brand new tuples */</span>
<a name="62" /><span class="True">      62:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlUdXBsZV9TRVRfSVRFTV8w"><span class="b">PyTuple_SET_ITEM</span></a><span class="f">(</span><span class="b">op</span><span class="f">,</span> <span class="b">i</span><span class="f">,</span> <span class="b">v</span><span class="f">)</span> <span class="f">(</span><span class="f">(</span><span class="f">(</span><span class="b">PyTupleObject</span> <span class="f">*</span><span class="f">)</span><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">)</span><span class="f">-&gt;</span><span class="b">ob_item</span><span class="f">[</span><span class="b">i</span><span class="f">]</span> <span class="f">=</span> <span class="b">v</span><span class="f">)</span>
<a name="63" /><span class="True">      63:</span> <span class="f">#</span><span class="n">endif</span>
<a name="64" /><span class="True">      64:</span> 
<a name="65" /><span class="True">      65:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyTuple_ClearFreeList</span><span class="f">(</span><span class="m">void</span><span class="f">)</span><span class="f">;</span>
<a name="66" /><span class="True">      66:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="67" /><span class="True">      67:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">void</span><span class="f">)</span> <span class="b">_PyTuple_DebugMallocStats</span><span class="f">(</span><span class="b">FILE</span> <span class="f">*</span><span class="b">out</span><span class="f">)</span><span class="f">;</span>
<a name="68" /><span class="True">      68:</span> <span class="f">#</span><span class="n">endif</span> <span class="k">/* Py_LIMITED_API */</span>
<a name="69" /><span class="True">      69:</span> 
<a name="70" /><span class="False">      70:</span> <span class="f">#</span><span class="n">ifdef</span> <span class="b">__cplusplus</span>
<a name="71" /><span class="False">      71:</span> <span class="f">}</span>
<a name="72" /><span class="True">      72:</span> <span class="f">#</span><span class="n">endif</span>
<a name="73" /><span class="True">      73:</span> <span class="f">#</span><span class="n">endif</span> <span class="k">/* !Py_TUPLEOBJECT_H */</span>
<a name="74" /><span class="True">      74:</span> </pre>
  </body>
</html>
